/*
 * Copyright 2014-2020  [fisco-dev]
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 *
 */
package org.fisco.bcos.sdk.transaction.codec.encode;

import org.fisco.bcos.sdk.crypto.keypair.CryptoKeyPair;
import org.fisco.bcos.sdk.crypto.signature.SignatureResult;
import org.fisco.bcos.sdk.transaction.model.po.RawTransaction;

/**
 * TransactionEncoderInterface @Description: TransactionEncoderInterface
 *
 * @author maojiayu
 */
public interface TransactionEncoderInterface {

    /**
     * Rlp encode and sign based on RawTransaction
     *
     * @param rawTransaction data to be encoded
     * @param signature signature result
     * @return encoded and signed transaction byte array
     */
    byte[] encode(RawTransaction rawTransaction, SignatureResult signature);

    /**
     * Rlp encode and sign based on RawTransaction
     *
     * @param rawTransaction data to be encoded
     * @param cryptoKeyPair keypair
     * @return encoded and signed transaction byte array
     */
    byte[] encodeAndSignBytes(RawTransaction rawTransaction, CryptoKeyPair cryptoKeyPair);

    /**
     * Rlp encode and sign based on RawTransaction
     *
     * @param rawTransaction data to be encoded
     * @param cryptoKeyPair keypair
     * @return encoded and signed transaction hexed String
     */
    String encodeAndSign(RawTransaction rawTransaction, CryptoKeyPair cryptoKeyPair);

    /**
     * Rlp encode and hash based on RawTransaction
     *
     * @param rawTransaction data to be encoded
     * @param cryptoKeyPair keypair
     * @return encoded and hashed transaction byte array
     */
    byte[] encodeAndHashBytes(RawTransaction rawTransaction, CryptoKeyPair cryptoKeyPair);
}
